3 * A class to help return information about a git repo MediaWiki may be inside
4 * This is used by Special:Version and is also useful for the LocalSettings.php
5 * of anyone working on large branches in git to setup config that show up only
6 * when specific branches are currently checked out.
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21 * http://www.gnu.org/copyleft/gpl.html
26 use MediaWiki\Shell\Shell
;
31 * Singleton for the repo at $IP
33 protected static $repo = null;
36 * Location of the .git directory
41 * Location of the repository
46 * Path to JSON cache file for pre-computed git information.
51 * Cached git information.
53 protected $cache = [];
56 * @var array|false Map of repo URLs to viewer URLs. Access via static method getViewers().
58 private static $viewers = false;
61 * @param string $repoDir The root directory of the repo where .git can be found
62 * @param bool $usePrecomputed Use precomputed information if available
63 * @see precomputeValues
65 public function __construct( $repoDir, $usePrecomputed = true ) {
66 $this->repoDir
= $repoDir;
67 $this->cacheFile
= self
::getCacheFilePath( $repoDir );
68 wfDebugLog( 'gitinfo',
69 "Computed cacheFile={$this->cacheFile} for {$repoDir}"
71 if ( $usePrecomputed &&
72 $this->cacheFile
!== null &&
73 is_readable( $this->cacheFile
)
75 $this->cache
= FormatJson
::decode(
76 file_get_contents( $this->cacheFile
),
79 wfDebugLog( 'gitinfo', "Loaded git data from cache for {$repoDir}" );
82 if ( !$this->cacheIsComplete() ) {
83 wfDebugLog( 'gitinfo', "Cache incomplete for {$repoDir}" );
84 $this->basedir
= $repoDir . DIRECTORY_SEPARATOR
. '.git';
85 if ( is_readable( $this->basedir
) && !is_dir( $this->basedir
) ) {
86 $GITfile = file_get_contents( $this->basedir
);
87 if ( strlen( $GITfile ) > 8 &&
88 substr( $GITfile, 0, 8 ) === 'gitdir: '
90 $path = rtrim( substr( $GITfile, 8 ), "\r\n" );
91 if ( $path[0] === '/' ||
substr( $path, 1, 1 ) === ':' ) {
92 // Path from GITfile is absolute
93 $this->basedir
= $path;
95 $this->basedir
= $repoDir . DIRECTORY_SEPARATOR
. $path;
103 * Compute the path to the cache file for a given directory.
105 * @param string $repoDir The root directory of the repo where .git can be found
106 * @return string Path to GitInfo cache file in $wgGitInfoCacheDirectory or
107 * fallback in the extension directory itself
110 protected static function getCacheFilePath( $repoDir ) {
111 global $IP, $wgGitInfoCacheDirectory;
113 if ( $wgGitInfoCacheDirectory ) {
114 // Convert both $IP and $repoDir to canonical paths to protect against
115 // $IP having changed between the settings files and runtime.
116 $realIP = realpath( $IP );
117 $repoName = realpath( $repoDir );
118 if ( $repoName === false ) {
119 // Unit tests use fake path names
120 $repoName = $repoDir;
122 if ( strpos( $repoName, $realIP ) === 0 ) {
123 // Strip $IP from path
124 $repoName = substr( $repoName, strlen( $realIP ) );
126 // Transform path to git repo to something we can safely embed in
128 $repoName = strtr( $repoName, DIRECTORY_SEPARATOR
, '-' );
129 $fileName = 'info' . $repoName . '.json';
130 $cachePath = "{$wgGitInfoCacheDirectory}/{$fileName}";
131 if ( is_readable( $cachePath ) ) {
136 return "$repoDir/gitinfo.json";
140 * Get the singleton for the repo at $IP
144 public static function repo() {
145 if ( is_null( self
::$repo ) ) {
147 self
::$repo = new self( $IP );
153 * Check if a string looks like a hex encoded SHA1 hash
155 * @param string $str The string to check
156 * @return bool Whether or not the string looks like a SHA1
158 public static function isSHA1( $str ) {
159 return !!preg_match( '/^[0-9A-F]{40}$/i', $str );
163 * Get the HEAD of the repo (without any opening "ref: ")
165 * @return string|bool The HEAD (git reference or SHA1) or false
167 public function getHead() {
168 if ( !isset( $this->cache
['head'] ) ) {
169 $headFile = "{$this->basedir}/HEAD";
172 if ( is_readable( $headFile ) ) {
173 $head = file_get_contents( $headFile );
175 if ( preg_match( "/ref: (.*)/", $head, $m ) ) {
176 $head = rtrim( $m[1] );
178 $head = rtrim( $head );
181 $this->cache
['head'] = $head;
183 return $this->cache
['head'];
187 * Get the SHA1 for the current HEAD of the repo
189 * @return string|bool A SHA1 or false
191 public function getHeadSHA1() {
192 if ( !isset( $this->cache
['headSHA1'] ) ) {
193 $head = $this->getHead();
196 // If detached HEAD may be a SHA1
197 if ( self
::isSHA1( $head ) ) {
200 // If not a SHA1 it may be a ref:
201 $refFile = "{$this->basedir}/{$head}";
202 $packedRefs = "{$this->basedir}/packed-refs";
203 $headRegex = preg_quote( $head, '/' );
204 if ( is_readable( $refFile ) ) {
205 $sha1 = rtrim( file_get_contents( $refFile ) );
206 } elseif ( is_readable( $packedRefs ) &&
207 preg_match( "/^([0-9A-Fa-f]{40}) $headRegex$/m", file_get_contents( $packedRefs ), $matches )
212 $this->cache
['headSHA1'] = $sha1;
214 return $this->cache
['headSHA1'];
218 * Get the commit date of HEAD entry of the git code repository
221 * @return int|bool Commit date (UNIX timestamp) or false
223 public function getHeadCommitDate() {
226 if ( !isset( $this->cache
['headCommitDate'] ) ) {
228 if ( is_file( $wgGitBin ) &&
229 is_executable( $wgGitBin ) &&
230 $this->getHead() !== false
236 '--format=format:%ct',
239 $gitDir = realpath( $this->basedir
);
240 $result = Shell
::command( $cmd )
241 ->environment( [ 'GIT_DIR' => $gitDir ] )
242 ->restrict( Shell
::RESTRICT_DEFAULT | Shell
::NO_NETWORK
)
243 ->whitelistPaths( [ $gitDir, $this->repoDir
] )
246 if ( $result->getExitCode() === 0 ) {
247 $date = (int)$result->getStdout();
250 $this->cache
['headCommitDate'] = $date;
252 return $this->cache
['headCommitDate'];
256 * Get the name of the current branch, or HEAD if not found
258 * @return string|bool The branch name, HEAD, or false
260 public function getCurrentBranch() {
261 if ( !isset( $this->cache
['branch'] ) ) {
262 $branch = $this->getHead();
264 preg_match( "#^refs/heads/(.*)$#", $branch, $m )
268 $this->cache
['branch'] = $branch;
270 return $this->cache
['branch'];
274 * Get an URL to a web viewer link to the HEAD revision.
276 * @return string|bool String if a URL is available or false otherwise
278 public function getHeadViewUrl() {
279 $url = $this->getRemoteUrl();
280 if ( $url === false ) {
283 foreach ( self
::getViewers() as $repo => $viewer ) {
284 $pattern = '#^' . $repo . '$#';
285 if ( preg_match( $pattern, $url, $matches ) ) {
286 $viewerUrl = preg_replace( $pattern, $viewer, $url );
287 $headSHA1 = $this->getHeadSHA1();
289 '%h' => substr( $headSHA1, 0, 7 ),
291 '%r' => urlencode( $matches[1] ),
294 return strtr( $viewerUrl, $replacements );
301 * Get the URL of the remote origin.
302 * @return string|bool String if a URL is available or false otherwise.
304 protected function getRemoteUrl() {
305 if ( !isset( $this->cache
['remoteURL'] ) ) {
306 $config = "{$this->basedir}/config";
308 if ( is_readable( $config ) ) {
309 MediaWiki\
suppressWarnings();
310 $configArray = parse_ini_file( $config, true );
311 MediaWiki\restoreWarnings
();
314 // Use the "origin" remote repo if available or any other repo if not.
315 if ( isset( $configArray['remote origin'] ) ) {
316 $remote = $configArray['remote origin'];
317 } elseif ( is_array( $configArray ) ) {
318 foreach ( $configArray as $sectionName => $sectionConf ) {
319 if ( substr( $sectionName, 0, 6 ) == 'remote' ) {
320 $remote = $sectionConf;
325 if ( $remote !== false && isset( $remote['url'] ) ) {
326 $url = $remote['url'];
329 $this->cache
['remoteURL'] = $url;
331 return $this->cache
['remoteURL'];
335 * Check to see if the current cache is fully populated.
337 * Note: This method is public only to make unit testing easier. There's
338 * really no strong reason that anything other than a test should want to
341 * @return bool True if all expected cache keys exist, false otherwise
343 public function cacheIsComplete() {
344 return isset( $this->cache
['head'] ) &&
345 isset( $this->cache
['headSHA1'] ) &&
346 isset( $this->cache
['headCommitDate'] ) &&
347 isset( $this->cache
['branch'] ) &&
348 isset( $this->cache
['remoteURL'] );
352 * Precompute and cache git information.
354 * Creates a JSON file in the cache directory associated with this
355 * GitInfo instance. This cache file will be used by subsequent GitInfo objects referencing
356 * the same directory to avoid needing to examine the .git directory again.
360 public function precomputeValues() {
361 if ( $this->cacheFile
!== null ) {
362 // Try to completely populate the cache
364 $this->getHeadSHA1();
365 $this->getHeadCommitDate();
366 $this->getCurrentBranch();
367 $this->getRemoteUrl();
369 if ( !$this->cacheIsComplete() ) {
370 wfDebugLog( 'gitinfo',
371 "Failed to compute GitInfo for \"{$this->basedir}\""
376 $cacheDir = dirname( $this->cacheFile
);
377 if ( !file_exists( $cacheDir ) &&
378 !wfMkdirParents( $cacheDir, null, __METHOD__
)
380 throw new MWException( "Unable to create GitInfo cache \"{$cacheDir}\"" );
383 file_put_contents( $this->cacheFile
, FormatJson
::encode( $this->cache
) );
388 * @see self::getHeadSHA1
391 public static function headSHA1() {
392 return self
::repo()->getHeadSHA1();
396 * @see self::getCurrentBranch
399 public static function currentBranch() {
400 return self
::repo()->getCurrentBranch();
404 * @see self::getHeadViewUrl()
405 * @return bool|string
407 public static function headViewUrl() {
408 return self
::repo()->getHeadViewUrl();
412 * Gets the list of repository viewers
415 protected static function getViewers() {
416 global $wgGitRepositoryViewers;
418 if ( self
::$viewers === false ) {
419 self
::$viewers = $wgGitRepositoryViewers;
420 Hooks
::run( 'GitViewers', [ &self
::$viewers ] );
423 return self
::$viewers;